home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / Xm / XmConvertUnits.z / XmConvertUnits
Encoding:
Text File  |  2002-10-03  |  7.1 KB  |  133 lines
  1.  
  2.  
  3.  
  4.      XXXXmmmmCCCCoooonnnnvvvveeeerrrrttttUUUUnnnniiiittttssss((((3333XXXX))))        UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV        XXXXmmmmCCCCoooonnnnvvvveeeerrrrttttUUUUnnnniiiittttssss((((3333XXXX))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           XXXXmmmmCCCCoooonnnnvvvveeeerrrrttttUUUUnnnniiiittttssss - A function that converts a value in one
  10.           unit type to another unit type
  11.  
  12.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.           #include <Xm/Xm.h>
  14.           iiiinnnntttt XXXXmmmmCCCCoooonnnnvvvveeeerrrrttttUUUUnnnniiiittttssss(
  15.           WWWWiiiiddddggggeeeetttt wwwwiiiiddddggggeeeetttt,
  16.           iiiinnnntttt oooorrrriiiieeeennnnttttaaaattttiiiioooonnnn,
  17.           iiiinnnntttt ffffrrrroooommmm____uuuunnnniiiitttt____ttttyyyyppppeeee,
  18.           iiiinnnntttt ffffrrrroooommmm____vvvvaaaalllluuuueeee,
  19.           iiiinnnntttt ttttoooo____uuuunnnniiiitttt____ttttyyyyppppeeee);
  20.  
  21.      VVVVEEEERRRRSSSSIIIIOOOONNNN
  22.           This page documents Motif 2.1.
  23.  
  24.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  25.           XXXXmmmmCCCCoooonnnnvvvveeeerrrrttttUUUUnnnniiiittttssss converts the value and returns it as the
  26.           return value from the function.  For resources of type,
  27.           dimension, or position, you can specify units using the
  28.           syntax described in the XXXXmmmmNNNNuuuunnnniiiittttTTTTyyyyppppeeee resource of the
  29.           XXXXmmmmPPPPrrrriiiimmmmiiiittttiiiivvvveeee reference page.
  30.  
  31.           _w_i_d_g_e_t    Specifies the widget for which the data is to be
  32.                     converted.
  33.  
  34.           _o_r_i_e_n_t_a_t_i_o_n
  35.                     Specifies whether the converter uses the
  36.                     horizontal or vertical screen resolution when
  37.                     performing the conversions. The
  38.                     _o_r_i_e_n_t_a_t_i_o_nparameter can have values of
  39.                     XXXXmmmmHHHHOOOORRRRIIIIZZZZOOOONNNNTTTTAAAALLLL or XXXXmmmmVVVVEEEERRRRTTTTIIIICCCCAAAALLLL.
  40.  
  41.           _f_r_o_m__u_n_i_t__t_y_p_e
  42.                     Specifies the current unit type of the supplied
  43.                     value
  44.  
  45.           _f_r_o_m__v_a_l_u_e
  46.                     Specifies the value to be converted
  47.  
  48.           _t_o__u_n_i_t__t_y_p_e
  49.                     Converts the value to the unit type specified
  50.  
  51.           The parameters _f_r_o_m__u_n_i_t__t_y_p_e and _t_o__u_n_i_t__t_y_p_e can have the
  52.           following values:
  53.  
  54.           XXXXmmmmPPPPIIIIXXXXEEEELLLLSSSS  All values provided to the widget are treated as
  55.                     pixel values. This is the default for the
  56.                     resource.
  57.  
  58.           XXXXmmmmMMMMIIIILLLLLLLLIIIIMMMMEEEETTTTEEEERRRRSSSS
  59.                     All values provided to the widget are treated as
  60.  
  61.  
  62.  
  63.      Page 1                                          (printed 10/3/02)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      XXXXmmmmCCCCoooonnnnvvvveeeerrrrttttUUUUnnnniiiittttssss((((3333XXXX))))        UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV        XXXXmmmmCCCCoooonnnnvvvveeeerrrrttttUUUUnnnniiiittttssss((((3333XXXX))))
  71.  
  72.  
  73.  
  74.                     millimeter values.
  75.  
  76.           _X_m_1_0_0_T_H__M_I_L_L_I_M_E_T_E_R_S
  77.                     All values provided to the widget are treated as
  78.                     1/100 of a millimeter.
  79.  
  80.           XXXXmmmmCCCCEEEENNNNTTTTIIIIMMMMEEEETTTTEEEERRRRSSSS
  81.                     All values provided to the widget are treated as
  82.                     centimeter values.
  83.  
  84.           XXXXmmmmIIIINNNNCCCCHHHHEEEESSSS  All values provided to the widget are treated as
  85.                     inch values.
  86.  
  87.           _X_m_1_0_0_0_T_H__I_N_C_H_E_S
  88.                     All values provided to the widget are treated as
  89.                     1/1000 of an inch.
  90.  
  91.           XXXXmmmmPPPPOOOOIIIINNNNTTTTSSSS  All values provided to the widget are treated as
  92.                     point values. A point is a unit used in text
  93.                     processing applications and is defined as 1/72 of
  94.                     an inch.
  95.  
  96.           _X_m_1_0_0_T_H__P_O_I_N_T_S
  97.                     All values provided to the widget are treated as
  98.                     1/100 of a point.  A point is a unit typically
  99.                     used in text processing applications and is
  100.                     defined as 1/72 of an inch.
  101.  
  102.           XXXXmmmmFFFFOOOONNNNTTTT____UUUUNNNNIIIITTTTSSSS
  103.                     All values provided to the widget are treated as
  104.                     normal font units. A font unit has horizontal and
  105.                     vertical components.  These are the values of the
  106.                     XmScreen resources XXXXmmmmNNNNhhhhoooorrrriiiizzzzoooonnnnttttaaaallllFFFFoooonnnnttttUUUUnnnniiiittttand
  107.                     XXXXmmmmNNNNvvvveeeerrrrttttiiiiccccaaaallllFFFFoooonnnnttttUUUUnnnniiiitttt.
  108.  
  109.           _X_m_1_0_0_T_H__F_O_N_T__U_N_I_T_S
  110.                     All values provided to the widget are treated as
  111.                     1/100 of a font unit.  A font unit has horizontal
  112.                     and vertical components.  These are the values of
  113.                     the XmScreen resources XXXXmmmmNNNNhhhhoooorrrriiiizzzzoooonnnnttttaaaallllFFFFoooonnnnttttUUUUnnnniiiittttand
  114.                     XXXXmmmmNNNNvvvveeeerrrrttttiiiiccccaaaallllFFFFoooonnnnttttUUUUnnnniiiitttt.
  115.  
  116.      RRRREEEETTTTUUUURRRRNNNN
  117.           Returns the converted value.  If a NULL widget, incorrect
  118.           _o_r_i_e_n_t_a_t_i_o_n, or incorrect _u_n_i_t__t_y_p_eis supplied as parameter
  119.           data, 0 (zero) is returned.
  120.  
  121.      RRRREEEELLLLAAAATTTTEEEEDDDD
  122.           XXXXmmmmPPPPrrrriiiimmmmiiiittttiiiivvvveeee, XXXXmmmmSSSSeeeettttFFFFoooonnnnttttUUUUnnnniiiittttssss(3), and XXXXmmmmSSSSccccrrrreeeeeeeennnn(3).
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.      Page 2                                          (printed 10/3/02)
  130.  
  131.  
  132.  
  133.